Skip to content

Fix: Update service catalog documentation link to latest version #1222

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Fix: Update service catalog documentation link to latest version #1222

wants to merge 2 commits into from
+2 −1

Conversation

@ranuka-laksika
Copy link

@ranuka-laksika ranuka-laksika commented Nov 10, 2025 •
edited by coderabbitai bot
Loading

Fixes wso2/api-manager#4538

Issue URL: wso2/api-manager#4538

Problem

The documentation link in the service catalog main page of the APIM Publisher portal was pointing to an outdated URL path and version-specific documentation.

Solution

Updated the documentation URL to point to the latest version and corrected the path structure:

Changes Made

  • Modified: portals/publisher/src/main/webapp/site/public/conf/settings.json
    • Updated docUrl from https://apim.docs.wso2.com/en/4.6.0/ to https://apim.docs.wso2.com/en/latest/
  • Modified: portals/publisher/src/main/webapp/source/src/app/components/ServiceCatalog/Listing/Onboarding.jsx
    • Updated documentation path to include manage-apis prefix
    • Fixed line length linting issue by properly formatting the URL concatenation

Build Information

  • Java 11 (Temurin-Hotspot 11.0.29+7)
  • Maven 3.6.3
  • Built component: Publisher portal
  • Generated artifact: publisher.war (32MB)

Artifacts Replaced

  • Frontend: Replaced publisher folder in wso2am-4.6.0/repository/deployment/server/webapps/
  • Generated new publisher.war from build and extracted to publisher folder

Testing

No testing required for frontend changes (as per workflow guidelines for apim-apps repository).

Modified wso2am Pack Download

The complete modified wso2am-4.6.0 pack is available as a GitHub Actions artifact.

🔗 Download from GitHub Actions

Artifact Details:

  • Name: wso2am-4.6.0-issue-56.zip
  • Size: 508MB
  • How to Download:
    1. Click the link above
    2. Scroll to "Artifacts" section
    3. Download the zip file
    4. Extract and use directly

Contents: Complete wso2am pack with all updated artifacts ready to use.

Summary by CodeRabbit

  • Documentation
    • Updated documentation links to reference the latest documentation version, ensuring users access current information
    • Corrected the "Get Started" link in the onboarding experience to direct to the appropriate learning resource

@ranuka-laksika
Fix: Update service catalog documentation link to latest version
8551ab2 
- Updated docUrl from version 4.6.0 to latest in settings.json
- Changed documentation path to include 'manage-apis' prefix
- Fixed line length linting issue by splitting long URL string
- Documentation now points to: https://apim.docs.wso2.com/en/latest/manage-apis/design/create-api/create-an-api-using-a-service/
@coderabbitai
Copy link

coderabbitai bot commented Nov 10, 2025 •
edited
Loading

Walkthrough

Two documentation URLs are updated: the global docUrl configuration is changed to reference the latest version instead of 4.6.0, and the Service Catalog "Get Started" link is redirected to the correct API design documentation path.

Changes

Cohort / File(s) Summary
Configuration Settings
portals/publisher/src/main/webapp/site/public/conf/settings.json		 Updated docUrl endpoint from version-specific 4.6.0 to latest to point to current documentation
Component Documentation Link
portals/publisher/src/main/webapp/source/src/app/components/ServiceCatalog/Listing/Onboarding.jsx		 Updated "Get Started" link destination path from design/... to manage-apis/design/... for correct API design documentation reference

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 A rabbit hops through docs so fine,
From version fixed to latest line,
The catalog now guides just right,
To manage-apis, shining bright!
Documentation trails aligned. ✨

Pre-merge checks and finishing touches

✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: updating documentation links in the service catalog to point to the latest version.
Linked Issues check ✅ Passed The PR successfully updates the documentation URL to the exact target specified in issue #4538, changing from version-specific to latest with the correct path structure.
Out of Scope Changes check ✅ Passed All changes are directly aligned with the linked issue requirement; only documentation URLs and their paths were updated without unrelated modifications.
Docstring Coverage ✅ Passed Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.
✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9eea9b0 and 8551ab2.

📒 Files selected for processing (2)
  • portals/publisher/src/main/webapp/site/public/conf/settings.json (1 hunks)
  • portals/publisher/src/main/webapp/source/src/app/components/ServiceCatalog/Listing/Onboarding.jsx (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: build-product
🔇 Additional comments (2)
portals/publisher/src/main/webapp/site/public/conf/settings.json (1)

45-45: Documentation URL correctly updated to latest version.

The change from version-specific 4.6.0 to latest is appropriate. The URL https://apim.docs.wso2.com/en/latest/ is the official WSO2 API Manager latest documentation, ensuring the link remains current without requiring future updates. Note: Sandbox environment restrictions prevent direct accessibility verification via curl (returns 403), but the URL format is confirmed valid through external sources. Verify accessibility in your environment if needed.

portals/publisher/src/main/webapp/source/src/app/components/ServiceCatalog/Listing/Onboarding.jsx (1)

119-120: LGTM! Documentation path correctly updated.

The path change from design/create-api/... to manage-apis/design/create-api/... aligns with the WSO2 API Manager documentation structure, and the URL splitting addresses line-length constraints. No stale references to the old path pattern exist in the codebase, and the change is isolated to a single file with consistent usage across similar documentation links.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

HeshanSudarshana
HeshanSudarshana reviewed Nov 17, 2025
View reviewed changes
portals/publisher/src/main/webapp/site/public/conf/settings.json Outdated
"loadDefaultLocales": false,
"supportedDocTypes": "application/vnd.openxmlformats-officedocument.wordprocessingml.document, application/msword, application/pdf, text/plain, application/vnd.ms-excel, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet, application/vnd.oasis.opendocument.text, application/vnd.oasis.opendocument.spreadsheet, application/json, application/x-yaml, .yaml, .md",
"docUrl": "https://apim.docs.wso2.com/en/4.6.0/",
"docUrl": "https://apim.docs.wso2.com/en/latest/",
Copy link
Contributor

@HeshanSudarshana HeshanSudarshana Nov 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ranuka-laksika This needs to be kept version-specific (4.6.0), as each release is required to point to its respective documentation space.

Copy link
Author

@ranuka-laksika ranuka-laksika Nov 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changed to 4.6.0

Copy link

@amilam amilam Nov 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@HeshanSudarshana we are doing this fix in the main branch. So, if we keep a specific version (say 4.6.0), what happens when we do a new release? That release will go with 4.6.0 doc link. Isn't that wrong? Isn't there a better fix for this?

Copy link
Contributor

@HeshanSudarshana HeshanSudarshana Nov 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@amilam usually at the start of a release cycle, we change the product version which are set to the previous release version to the next release version [1][2].

Therefore, changing only this URL could introduce a bit of a maintenance overhead to keep track of in future releases.

[1] https://github.com/wso2/apim-apps/pull/1045/files
[2] https://github.com/wso2/apim-apps/pull/1054/files

@HeshanSudarshana HeshanSudarshana dismissed their stale review November 17, 2025 08:16

The comment needs to be addressed before merging

@sonarqubecloud
Copy link

sonarqubecloud bot commented Nov 17, 2025

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@amilam amilam amilam left review comments

@HeshanSudarshana HeshanSudarshana HeshanSudarshana approved these changes

@chamilaadhi chamilaadhi chamilaadhi approved these changes

@npamudika npamudika npamudika approved these changes

@lasanthaS lasanthaS Awaiting requested review from lasanthaS lasanthaS is a code owner

@Krishanx92 Krishanx92 Awaiting requested review from Krishanx92 Krishanx92 is a code owner

@tharikaGitHub tharikaGitHub Awaiting requested review from tharikaGitHub tharikaGitHub is a code owner

@piyumaldk piyumaldk Awaiting requested review from piyumaldk piyumaldk is a code owner

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

The link should be updates in the service-catalog main page

5 participants

@ranuka-laksika @amilam @chamilaadhi @npamudika @HeshanSudarshana